\hypertarget{dox__exa__2_8h}{}\doxysection{/home/st/\+REPOBARE/\+\_\+repo/\+NBash/.arb/util/doxygen.ram/.grot/exa\+\_\+2.d/exa\+\_\+2.d/poroject2.ws/dox\+\_\+exa\+\_\+2.h File Reference}
\label{dox__exa__2_8h}\index{/home/st/REPOBARE/\_repo/NBash/.arb/util/doxygen.ram/.grot/exa\_2.d/exa\_2.d/poroject2.ws/dox\_exa\_2.h@{/home/st/REPOBARE/\_repo/NBash/.arb/util/doxygen.ram/.grot/exa\_2.d/exa\_2.d/poroject2.ws/dox\_exa\_2.h}}


File containing example of doxygen usage for quick reference.  


{\ttfamily \#include $<$systemheader1.\+h$>$}\newline
{\ttfamily \#include $<$systemheader2.\+h$>$}\newline
{\ttfamily \#include $<$box/header1.\+h$>$}\newline
{\ttfamily \#include $<$box/header2.\+h$>$}\newline
{\ttfamily \#include \char`\"{}local\+\_\+header1.\+h\char`\"{}}\newline
{\ttfamily \#include \char`\"{}local\+\_\+header2.\+h\char`\"{}}\newline
Include dependency graph for dox\+\_\+exa\+\_\+2.\+h\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{dox__exa__2_8h__incl}
\end{center}
\end{figure}
\doxysubsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \mbox{\hyperlink{struct_box_struct__struct}{Box\+Struct\+\_\+struct}}
\begin{DoxyCompactList}\small\item\em Use brief, otherwise the index won\textquotesingle{}t have a brief explanation. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Typedefs}
\begin{DoxyCompactItemize}
\item 
typedef enum \mbox{\hyperlink{poroject2_8ws_2doxygen__c_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4}{Box\+Enum\+\_\+enum}} \mbox{\hyperlink{dox__exa__2_8h_a2345a085bbc7582971ddac2b2c7d1d7e}{Box\+Enum}}
\begin{DoxyCompactList}\small\item\em Use brief, otherwise the index won\textquotesingle{}t have a brief explanation. \end{DoxyCompactList}\item 
typedef struct \mbox{\hyperlink{struct_box_struct__struct}{Box\+Struct\+\_\+struct}} \mbox{\hyperlink{dox__exa__2_8h_a40a25b8d3b226c01f7f83e410c6b58d7}{Box\+Struct}}
\begin{DoxyCompactList}\small\item\em Use brief, otherwise the index won\textquotesingle{}t have a brief explanation. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item 
enum \mbox{\hyperlink{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4}{Box\+Enum\+\_\+enum}} \{ \newline
{\bfseries BOXENUM\+\_\+\+FIRST}
, {\bfseries BOXENUM\+\_\+\+SECOND}
, {\bfseries BOXENUM\+\_\+\+ETC}
, \mbox{\hyperlink{poroject_8ws_2doxygen__c_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a2bf0bdd7b9b287724c66f6c0f74ceb01}{BOXENUM\+\_\+\+FIRST}}
, \newline
\mbox{\hyperlink{poroject_8ws_2doxygen__c_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a3ede3b6dfb2dbdac72634f0334e11c63}{BOXENUM\+\_\+\+SECOND}}
, \mbox{\hyperlink{poroject_8ws_2doxygen__c_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a227130e825c6c4506cc4a226539d85fb}{BOXENUM\+\_\+\+ETC}}
, \mbox{\hyperlink{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a2bf0bdd7b9b287724c66f6c0f74ceb01}{BOXENUM\+\_\+\+FIRST}}
, \mbox{\hyperlink{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a3ede3b6dfb2dbdac72634f0334e11c63}{BOXENUM\+\_\+\+SECOND}}
, \newline
\mbox{\hyperlink{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a227130e825c6c4506cc4a226539d85fb}{BOXENUM\+\_\+\+ETC}}
, \mbox{\hyperlink{poroject2_8ws_2doxygen__c_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a2bf0bdd7b9b287724c66f6c0f74ceb01}{BOXENUM\+\_\+\+FIRST}}
, \mbox{\hyperlink{poroject2_8ws_2doxygen__c_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a3ede3b6dfb2dbdac72634f0334e11c63}{BOXENUM\+\_\+\+SECOND}}
, \mbox{\hyperlink{poroject2_8ws_2doxygen__c_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a227130e825c6c4506cc4a226539d85fb}{BOXENUM\+\_\+\+ETC}}
 \}
\begin{DoxyCompactList}\small\item\em Use brief, otherwise the index won\textquotesingle{}t have a brief explanation. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
BOXEXPORT \mbox{\hyperlink{struct_box_struct__struct}{Box\+Struct}} $\ast$ \mbox{\hyperlink{dox__exa__2_8h_aaddf8ced9406a68229baee8c1e922b6a}{Box\+\_\+\+The\+\_\+\+Function\+\_\+\+Name}} (Box\+Param\+Type1 param1, Box\+Param\+Type2 param2)
\begin{DoxyCompactList}\small\item\em Example showing how to document a function with Doxygen. \end{DoxyCompactList}\item 
BOXEXPORT void $\ast$ \mbox{\hyperlink{dox__exa__2_8h_a7ec4699a4197d74b5487929228b0597c}{Box\+\_\+\+The\+\_\+\+Second\+\_\+\+Function}} (void)
\begin{DoxyCompactList}\small\item\em A simple stub function to show how links do work. \end{DoxyCompactList}\item 
BOXEXPORT void \mbox{\hyperlink{dox__exa__2_8h_a01d1bdf75bc1d4b6445faeafa8fd853d}{Box\+\_\+\+The\+\_\+\+Last\+\_\+\+One}} (void)
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
File containing example of doxygen usage for quick reference. 

\begin{DoxyAuthor}{Author}
My Self 
\end{DoxyAuthor}
\begin{DoxyDate}{Date}
9 Sep 2012
\end{DoxyDate}
Here typically goes a more extensive explanation of what the header defines. Doxygens tags are words preceeded by either a backslash \textbackslash{} or by an at symbol @. \begin{DoxySeeAlso}{See also}
\href{http://www.stack.nl/~dimitri/doxygen/docblocks.html}{\texttt{ http\+://www.\+stack.\+nl/$\sim$dimitri/doxygen/docblocks.\+html}} 

\href{http://www.stack.nl/~dimitri/doxygen/commands.html}{\texttt{ http\+://www.\+stack.\+nl/$\sim$dimitri/doxygen/commands.\+html}} 
\end{DoxySeeAlso}


\doxysubsection{Typedef Documentation}
\mbox{\Hypertarget{dox__exa__2_8h_a2345a085bbc7582971ddac2b2c7d1d7e}\label{dox__exa__2_8h_a2345a085bbc7582971ddac2b2c7d1d7e}} 
\index{dox\_exa\_2.h@{dox\_exa\_2.h}!BoxEnum@{BoxEnum}}
\index{BoxEnum@{BoxEnum}!dox\_exa\_2.h@{dox\_exa\_2.h}}
\doxysubsubsection{\texorpdfstring{BoxEnum}{BoxEnum}}
{\footnotesize\ttfamily typedef enum \mbox{\hyperlink{poroject2_8ws_2doxygen__c_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4}{Box\+Enum\+\_\+enum}} Box\+Enum}



Use brief, otherwise the index won\textquotesingle{}t have a brief explanation. 

Detailed explanation. \mbox{\Hypertarget{dox__exa__2_8h_a40a25b8d3b226c01f7f83e410c6b58d7}\label{dox__exa__2_8h_a40a25b8d3b226c01f7f83e410c6b58d7}} 
\index{dox\_exa\_2.h@{dox\_exa\_2.h}!BoxStruct@{BoxStruct}}
\index{BoxStruct@{BoxStruct}!dox\_exa\_2.h@{dox\_exa\_2.h}}
\doxysubsubsection{\texorpdfstring{BoxStruct}{BoxStruct}}
{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{struct_box_struct__struct}{Box\+Struct\+\_\+struct}} \mbox{\hyperlink{struct_box_struct__struct}{Box\+Struct}}}



Use brief, otherwise the index won\textquotesingle{}t have a brief explanation. 

Detailed explanation. 

\doxysubsection{Enumeration Type Documentation}
\mbox{\Hypertarget{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4}\label{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4}} 
\index{dox\_exa\_2.h@{dox\_exa\_2.h}!BoxEnum\_enum@{BoxEnum\_enum}}
\index{BoxEnum\_enum@{BoxEnum\_enum}!dox\_exa\_2.h@{dox\_exa\_2.h}}
\doxysubsubsection{\texorpdfstring{BoxEnum\_enum}{BoxEnum\_enum}}
{\footnotesize\ttfamily enum Box\+Enum\+\_\+enum}



Use brief, otherwise the index won\textquotesingle{}t have a brief explanation. 

Detailed explanation. \begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{BOXENUM\_FIRST@{BOXENUM\_FIRST}!dox\_exa\_2.h@{dox\_exa\_2.h}}\index{dox\_exa\_2.h@{dox\_exa\_2.h}!BOXENUM\_FIRST@{BOXENUM\_FIRST}}}\mbox{\Hypertarget{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a2bf0bdd7b9b287724c66f6c0f74ceb01}\label{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a2bf0bdd7b9b287724c66f6c0f74ceb01}} 
BOXENUM\+\_\+\+FIRST&Some documentation for first. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BOXENUM\_SECOND@{BOXENUM\_SECOND}!dox\_exa\_2.h@{dox\_exa\_2.h}}\index{dox\_exa\_2.h@{dox\_exa\_2.h}!BOXENUM\_SECOND@{BOXENUM\_SECOND}}}\mbox{\Hypertarget{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a3ede3b6dfb2dbdac72634f0334e11c63}\label{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a3ede3b6dfb2dbdac72634f0334e11c63}} 
BOXENUM\+\_\+\+SECOND&Some documentation for second. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BOXENUM\_ETC@{BOXENUM\_ETC}!dox\_exa\_2.h@{dox\_exa\_2.h}}\index{dox\_exa\_2.h@{dox\_exa\_2.h}!BOXENUM\_ETC@{BOXENUM\_ETC}}}\mbox{\Hypertarget{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a227130e825c6c4506cc4a226539d85fb}\label{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a227130e825c6c4506cc4a226539d85fb}} 
BOXENUM\+\_\+\+ETC&Etc. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BOXENUM\_FIRST@{BOXENUM\_FIRST}!dox\_exa\_2.h@{dox\_exa\_2.h}}\index{dox\_exa\_2.h@{dox\_exa\_2.h}!BOXENUM\_FIRST@{BOXENUM\_FIRST}}}\mbox{\Hypertarget{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a2bf0bdd7b9b287724c66f6c0f74ceb01}\label{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a2bf0bdd7b9b287724c66f6c0f74ceb01}} 
BOXENUM\+\_\+\+FIRST&Some documentation for first. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BOXENUM\_SECOND@{BOXENUM\_SECOND}!dox\_exa\_2.h@{dox\_exa\_2.h}}\index{dox\_exa\_2.h@{dox\_exa\_2.h}!BOXENUM\_SECOND@{BOXENUM\_SECOND}}}\mbox{\Hypertarget{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a3ede3b6dfb2dbdac72634f0334e11c63}\label{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a3ede3b6dfb2dbdac72634f0334e11c63}} 
BOXENUM\+\_\+\+SECOND&Some documentation for second. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BOXENUM\_ETC@{BOXENUM\_ETC}!dox\_exa\_2.h@{dox\_exa\_2.h}}\index{dox\_exa\_2.h@{dox\_exa\_2.h}!BOXENUM\_ETC@{BOXENUM\_ETC}}}\mbox{\Hypertarget{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a227130e825c6c4506cc4a226539d85fb}\label{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a227130e825c6c4506cc4a226539d85fb}} 
BOXENUM\+\_\+\+ETC&Etc. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BOXENUM\_FIRST@{BOXENUM\_FIRST}!dox\_exa\_2.h@{dox\_exa\_2.h}}\index{dox\_exa\_2.h@{dox\_exa\_2.h}!BOXENUM\_FIRST@{BOXENUM\_FIRST}}}\mbox{\Hypertarget{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a2bf0bdd7b9b287724c66f6c0f74ceb01}\label{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a2bf0bdd7b9b287724c66f6c0f74ceb01}} 
BOXENUM\+\_\+\+FIRST&Some documentation for first. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BOXENUM\_SECOND@{BOXENUM\_SECOND}!dox\_exa\_2.h@{dox\_exa\_2.h}}\index{dox\_exa\_2.h@{dox\_exa\_2.h}!BOXENUM\_SECOND@{BOXENUM\_SECOND}}}\mbox{\Hypertarget{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a3ede3b6dfb2dbdac72634f0334e11c63}\label{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a3ede3b6dfb2dbdac72634f0334e11c63}} 
BOXENUM\+\_\+\+SECOND&Some documentation for second. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BOXENUM\_ETC@{BOXENUM\_ETC}!dox\_exa\_2.h@{dox\_exa\_2.h}}\index{dox\_exa\_2.h@{dox\_exa\_2.h}!BOXENUM\_ETC@{BOXENUM\_ETC}}}\mbox{\Hypertarget{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a227130e825c6c4506cc4a226539d85fb}\label{dox__exa__2_8h_abdf4994e8e07b3eda6c6a5a9bf5357e4a227130e825c6c4506cc4a226539d85fb}} 
BOXENUM\+\_\+\+ETC&Etc. \\
\hline

\end{DoxyEnumFields}


Definition at line 50 of file dox\+\_\+exa\+\_\+2.\+h.



\doxysubsection{Function Documentation}
\mbox{\Hypertarget{dox__exa__2_8h_aaddf8ced9406a68229baee8c1e922b6a}\label{dox__exa__2_8h_aaddf8ced9406a68229baee8c1e922b6a}} 
\index{dox\_exa\_2.h@{dox\_exa\_2.h}!Box\_The\_Function\_Name@{Box\_The\_Function\_Name}}
\index{Box\_The\_Function\_Name@{Box\_The\_Function\_Name}!dox\_exa\_2.h@{dox\_exa\_2.h}}
\doxysubsubsection{\texorpdfstring{Box\_The\_Function\_Name()}{Box\_The\_Function\_Name()}}
{\footnotesize\ttfamily BOXEXPORT \mbox{\hyperlink{struct_box_struct__struct}{Box\+Struct}}$\ast$ Box\+\_\+\+The\+\_\+\+Function\+\_\+\+Name (\begin{DoxyParamCaption}\item[{Box\+Param\+Type1}]{param1,  }\item[{Box\+Param\+Type2}]{param2 }\end{DoxyParamCaption})}



Example showing how to document a function with Doxygen. 

Description of what the function does. This part may refer to the parameters of the function, like {\ttfamily param1} or {\ttfamily param2}. A word of code can also be inserted like {\ttfamily this} which is equivalent to {\ttfamily this} and can be useful to say that the function returns a {\ttfamily void} or an {\ttfamily int}. If you want to have more than one word in typewriter font, then just use $<$tt$>$. We can also include text verbatim, \begin{DoxyVerb}like this\end{DoxyVerb}
 Sometimes it is also convenient to include an example of usage\+: 
\begin{DoxyCode}{0}
\DoxyCodeLine{\mbox{\hyperlink{struct_box_struct__struct}{BoxStruct}} *out = \mbox{\hyperlink{poroject_8ws_2doxygen__c_8h_aaddf8ced9406a68229baee8c1e922b6a}{Box\_The\_Function\_Name}}(param1, param2);}
\DoxyCodeLine{printf(\textcolor{stringliteral}{"{}something...\(\backslash\)n"{}});}

\end{DoxyCode}
 Or, 
\begin{DoxyCode}{0}
\DoxyCodeLine{pyval = python\_func(arg1, arg2)}
\DoxyCodeLine{\textcolor{keywordflow}{print} pyval}

\end{DoxyCode}
 when the language is not the one used in the current source file (but {\bfseries{be careful}} as this may be supported only by recent versions of Doxygen). By the way, {\bfseries{this is how you write bold text}} or, if it is just one word, then you can just do {\bfseries{this}}. 
\begin{DoxyParams}{Parameters}
{\em param1} & Description of the first parameter of the function. \\
\hline
{\em param2} & The second one, which follows {\ttfamily param1}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Describe what the function returns. 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{dox__exa__2_8h_a7ec4699a4197d74b5487929228b0597c}{Box\+\_\+\+The\+\_\+\+Second\+\_\+\+Function}} 

\mbox{\hyperlink{dox__exa__2_8h_a01d1bdf75bc1d4b6445faeafa8fd853d}{Box\+\_\+\+The\+\_\+\+Last\+\_\+\+One}} 

\href{http://website/}{\texttt{ http\+://website/}} 
\end{DoxySeeAlso}
\begin{DoxyNote}{Note}
Something to note. 
\end{DoxyNote}
\begin{DoxyWarning}{Warning}
Warning. 
\end{DoxyWarning}
\mbox{\Hypertarget{dox__exa__2_8h_a01d1bdf75bc1d4b6445faeafa8fd853d}\label{dox__exa__2_8h_a01d1bdf75bc1d4b6445faeafa8fd853d}} 
\index{dox\_exa\_2.h@{dox\_exa\_2.h}!Box\_The\_Last\_One@{Box\_The\_Last\_One}}
\index{Box\_The\_Last\_One@{Box\_The\_Last\_One}!dox\_exa\_2.h@{dox\_exa\_2.h}}
\doxysubsubsection{\texorpdfstring{Box\_The\_Last\_One()}{Box\_The\_Last\_One()}}
{\footnotesize\ttfamily BOXEXPORT void Box\+\_\+\+The\+\_\+\+Last\+\_\+\+One (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}

Brief can be omitted. If you configure Doxygen with {\ttfamily JAVADOC\+\_\+\+AUTOBRIEF=YES}, then the first Line of the comment is used instead. In this function this would be as if \begin{DoxyVerb}@brief Brief can be omitted. \end{DoxyVerb}
 was used instead. \mbox{\Hypertarget{dox__exa__2_8h_a7ec4699a4197d74b5487929228b0597c}\label{dox__exa__2_8h_a7ec4699a4197d74b5487929228b0597c}} 
\index{dox\_exa\_2.h@{dox\_exa\_2.h}!Box\_The\_Second\_Function@{Box\_The\_Second\_Function}}
\index{Box\_The\_Second\_Function@{Box\_The\_Second\_Function}!dox\_exa\_2.h@{dox\_exa\_2.h}}
\doxysubsubsection{\texorpdfstring{Box\_The\_Second\_Function()}{Box\_The\_Second\_Function()}}
{\footnotesize\ttfamily BOXEXPORT void$\ast$ Box\+\_\+\+The\+\_\+\+Second\+\_\+\+Function (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



A simple stub function to show how links do work. 

Links are generated automatically for webpages (like \href{http://www.google.co.uk}{\texttt{ http\+://www.\+google.\+co.\+uk}}) and for structures, like \mbox{\hyperlink{struct_box_struct__struct}{Box\+Struct\+\_\+struct}}. For typedef-\/ed types use \mbox{\hyperlink{dox__exa__2_8h_a40a25b8d3b226c01f7f83e410c6b58d7}{Box\+Struct}}. For functions, automatic links are generated when the parenthesis () follow the name of the function, like \mbox{\hyperlink{dox__exa__2_8h_aaddf8ced9406a68229baee8c1e922b6a}{Box\+\_\+\+The\+\_\+\+Function\+\_\+\+Name()}}. Alternatively, you can use \mbox{\hyperlink{dox__exa__2_8h_aaddf8ced9406a68229baee8c1e922b6a}{Box\+\_\+\+The\+\_\+\+Function\+\_\+\+Name}}. \begin{DoxyReturn}{Returns}
{\ttfamily NULL} is always returned. 
\end{DoxyReturn}
